feat: added option to generate basic `ape-config.yaml` file if `[tool.ape.plugins]` property is specified inside pyproject.toml file [APE-1312] #1618

Aviksaikat · 2023-08-23T00:45:17Z

…

What I did

Added option to specify plugins in the ape-config.yaml file based on the [tool.ape.plugins] property of pyproject.toml file.

fixes: #1571

How I did it

Added functions for parsing the pyproject.toml file & look for lines which have the ape- initials & then stripping them & put them inside the ape-config.yaml file with proper formatting

How to verify it

Create a new folder with this pyproject.toml file

[tool.poetry]
name = "testing ape-config"
version = "0.1.0"
description = ""
authors = ["Your Name <[email protected]>"]
readme = "README.md"
packages = [{include = "Flash_loan_arbritage"}]

[tool.poetry.dependencies]
python = ">=3.10,<3.11"
eth-ape = "*"
ape-alchemy = "^0.6.2"
ape-solidity= "^0.6.7"
ape-foundry = "^0.6.14"
ape-etherscan = "*"


[tool.ape.plugins]
ape-alchemy = "*"
ape-solidity = "*"
ape-foundry = "*"
ape-etherscan = "*"

# working on adding support for this property
[tool.ape.network]
ecosystem = "ethereum"
default_network = "mainnet-fork"
default_provider = "foundry"

# working on adding support for this property
[tool.ape.tests]
mnemonic = "test test test test test test test test test test test junk"
number_of_test_accounts = 10

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

Then create a new virtual environment by doing poetry install && poetry shell
Then run pip install -e <path/to/the/cloned/repo/with/this/revision/
Then run ape init
Done

POC

Checklist

All changes are completed
New test cases have been added
Documentation has been updated

…e.plugins] property is specified inside pyproject.toml file

…0] (#1625)

…uration

antazoey

Some missing things,
and I think there is a helpful standard library to assist with this and simplify the code we have to manage

src/ape_init/_cli.py

docs: Ethereum spelling in example

…uration

…r feedbacks

setup.py

Co-authored-by: El De-dog-lo <[email protected]>

antazoey

nice work but things are in the wrong spot and we should be configuring the tool directly instead of generating a config from a config

antazoey · 2023-08-29T14:30:03Z

src/ape_init/_cli.py

+
+def read_dependencies_from_toml(file_path, cli_ctx) -> List[str]:
+
+    with open("./pyproject.toml", "rb") as file:


this should all happen in the config manage, not in ape-init plugin.
And then you can use the project_manager.path as the base here instead of cwd

antazoey · 2023-08-29T14:31:05Z

src/ape_init/_cli.py

+    return ape_plugins
+
+
+def write_ape_config_yml(dependencies: List[str], file_to_write: Path):


instead of writing an ape file, the ConfigManager should read the values from the pyproject.toml and treat it the same as if the config file had existed. There is not reason to configure twice, even if one is auto-generated.

github-actions · 2023-10-06T01:49:02Z

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

Aviksaikat · 2023-10-06T08:52:32Z

any update on this one ?

antazoey · 2023-10-06T13:17:15Z

any update on this one ?

There is a quite a lot of unaddressed feedback. Basically, we want this to be another source of config rather than creating a config file from it

Aviksaikat · 2023-10-06T13:23:06Z

so let's make it a draft and wait for further feedback?

antazoey · 2023-10-09T19:43:18Z

so let's make it a draft and wait for further feedback?

We are not able to provide any more feedback until the approach matches more with the design of having the pyproject.toml be source of config rather than it generating a new config file.

fubuloubu · 2023-10-09T21:18:09Z

so let's make it a draft and wait for further feedback?

We are not able to provide any more feedback until the approach matches more with the design of having the pyproject.toml be source of config rather than it generating a new config file.

to expand on this, make it look something like this I suppose:

[tools.ape]
plugins = [
    etherscan,
    vyper,
]

github-actions · 2023-11-09T01:49:22Z

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

fubuloubu · 2023-11-09T04:02:51Z

I think this approach should be closed for now. I am in favor of migrating the ape-config.yaml file actually into pyproject.toml but it needs a lot of further thought

feat: added option to generate basic ape-config.yaml file if [tool.ap…

d361b1b

…e.plugins] property is specified inside pyproject.toml file

Aviksaikat and others added 4 commits August 23, 2023 23:50

Merge branch 'main' into feat/pyproject.toml-based-ape-configuration

d6beda0

fix: issues causing dev messages from working on vyper 0.3.9 [APE-132…

e48fece

…0] (#1625)

Merge branch 'ApeWorX:main' into feat/pyproject.toml-based-ape-config…

c656b30

…uration

feat: show plugin name in log messages [APE-1327] (#1628)

ceeb7e1

antazoey requested changes Aug 28, 2023

View reviewed changes

src/ape_init/_cli.py Outdated Show resolved Hide resolved

src/ape_init/_cli.py Outdated Show resolved Hide resolved

src/ape_init/_cli.py Outdated Show resolved Hide resolved

src/ape_init/_cli.py Outdated Show resolved Hide resolved

0xJchen and others added 5 commits August 28, 2023 10:35

Update networks.md (#1629)

bd6cf06

docs: Ethereum spelling in example

fix: attempt fixing geth install [APE-1333] (#1634)

66703f0

fix: pluggy (#1633)

0e584b3

fix: weird type error (#1631)

6c58d7e

Merge branch 'ApeWorX:main' into feat/pyproject.toml-based-ape-config…

e70f92a

…uration

antazoey force-pushed the main branch 2 times, most recently from 45b0779 to 6bdce6a Compare August 28, 2023 21:05

Aviksaikat and others added 4 commits August 28, 2023 22:19

removed vanilla file read to tomli to read toml files & updated as pe…

b7f22e4

…r feedbacks

Merge branch 'main' into feat/pyproject.toml-based-ape-configuration

137a912

import fixed & mypy erros fixed

6a027e4

black formatted

45630ba

fubuloubu reviewed Aug 28, 2023

View reviewed changes

setup.py Outdated Show resolved Hide resolved

Aviksaikat and others added 2 commits August 28, 2023 23:28

Update setup.py

dccabf4

Co-authored-by: El De-dog-lo <[email protected]>

setup.py dependency fixed

1073fef

antazoey reviewed Aug 29, 2023

View reviewed changes

github-actions bot added the stale No activity for 30 days label Oct 6, 2023

github-actions bot removed the stale No activity for 30 days label Oct 7, 2023

github-actions bot added the stale No activity for 30 days label Nov 9, 2023

fubuloubu closed this Nov 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: added option to generate basic `ape-config.yaml` file if `[tool.ape.plugins]` property is specified inside pyproject.toml file [APE-1312] #1618

feat: added option to generate basic `ape-config.yaml` file if `[tool.ape.plugins]` property is specified inside pyproject.toml file [APE-1312] #1618

Aviksaikat commented Aug 23, 2023

antazoey left a comment

antazoey left a comment

antazoey Aug 29, 2023

antazoey Aug 29, 2023

github-actions bot commented Oct 6, 2023

Aviksaikat commented Oct 6, 2023

antazoey commented Oct 6, 2023

Aviksaikat commented Oct 6, 2023 •

edited

Loading

antazoey commented Oct 9, 2023 •

edited

Loading

fubuloubu commented Oct 9, 2023

github-actions bot commented Nov 9, 2023

fubuloubu commented Nov 9, 2023


		def read_dependencies_from_toml(file_path, cli_ctx) -> List[str]:

		with open("./pyproject.toml", "rb") as file:

		return ape_plugins


		def write_ape_config_yml(dependencies: List[str], file_to_write: Path):

feat: added option to generate basic ape-config.yaml file if [tool.ape.plugins] property is specified inside pyproject.toml file [APE-1312] #1618

feat: added option to generate basic ape-config.yaml file if [tool.ape.plugins] property is specified inside pyproject.toml file [APE-1312] #1618

Conversation

Aviksaikat commented Aug 23, 2023

What I did

How I did it

How to verify it

POC

Checklist

antazoey left a comment

Choose a reason for hiding this comment

antazoey left a comment

Choose a reason for hiding this comment

antazoey Aug 29, 2023

Choose a reason for hiding this comment

antazoey Aug 29, 2023

Choose a reason for hiding this comment

github-actions bot commented Oct 6, 2023

Aviksaikat commented Oct 6, 2023

antazoey commented Oct 6, 2023

Aviksaikat commented Oct 6, 2023 • edited Loading

antazoey commented Oct 9, 2023 • edited Loading

fubuloubu commented Oct 9, 2023

github-actions bot commented Nov 9, 2023

fubuloubu commented Nov 9, 2023

feat: added option to generate basic `ape-config.yaml` file if `[tool.ape.plugins]` property is specified inside pyproject.toml file [APE-1312] #1618

feat: added option to generate basic `ape-config.yaml` file if `[tool.ape.plugins]` property is specified inside pyproject.toml file [APE-1312] #1618

Aviksaikat commented Oct 6, 2023 •

edited

Loading

antazoey commented Oct 9, 2023 •

edited

Loading